home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / content / nsILink.h < prev    next >
C/C++ Source or Header  |  2006-05-08  |  4KB  |  106 lines
  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1998
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *   L. David Baron <dbaron@dbaron.org>
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38. #ifndef nsILink_h___
  39. #define nsILink_h___
  40.  
  41. #include "nsISupports.h"
  42. #include "nsILinkHandler.h" // definition of nsLinkState
  43.  
  44. class nsIURI;
  45.  
  46. // IID for the nsILink interface
  47. #define NS_ILINK_IID    \
  48. { 0x0c212bc4, 0xfcd7, 0x479d,  \
  49.   { 0x8c, 0x3f, 0x3b, 0xe8, 0xe6, 0x78, 0x74, 0x50 } }
  50.  
  51. /**
  52.  * This interface allows SelectorMatches to get the canonical
  53.  * URL pointed to by an element representing a link and allows
  54.  * it to store the visited state of a link element in the link.
  55.  * It is needed for performance reasons (to prevent copying of
  56.  * strings and excessive calls to history).
  57.  */
  58. class nsILink : public nsISupports {
  59. public:
  60.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ILINK_IID)
  61.  
  62.   /**
  63.    * Get the cached state of the link.  If the state is unknown, 
  64.    * return eLinkState_Unknown.
  65.    *
  66.    * @param aState [out] The cached link state of the link.
  67.    * @return NS_OK
  68.    */
  69.   NS_IMETHOD GetLinkState(nsLinkState &aState) = 0;
  70.  
  71.   /**
  72.    * Set the cached state of the link.
  73.    *
  74.    * @param aState The cached link state of the link.
  75.    * @return NS_OK
  76.    */
  77.   NS_IMETHOD SetLinkState(nsLinkState aState) = 0;
  78.  
  79.   /**
  80.     * Get a pointer to the fully href URI (fully resolved and canonicalized,
  81.     * since it's an nsIURI object).
  82.     *
  83.     * @param aURI [out] A pointer to be filled in with a pointer to the URI
  84.     *             If the element has no HREF attribute, it is set to nsnull.
  85.     * @return NS_OK if the out pointer is filled in (possibly with nsnull)
  86.     */
  87.   NS_IMETHOD GetHrefURI(nsIURI** aURI) = 0;
  88.  
  89.   /**
  90.    * Dispatch a LinkAdded event to the nsIChromeEventHandler for this document.
  91.    * This is used to notify the chrome listeners when restoring a page
  92.    * presentation.  Currently, this only applies to HTML <link> elements.
  93.    */
  94.   NS_IMETHOD LinkAdded() = 0;
  95.  
  96.   /**
  97.    * Dispatch a LinkRemoved event to the nsIChromeEventHandler for this
  98.    * document.  This is used to notify the chrome listeners when saving a page
  99.    * presentation (since the document is not torn down).  Currently, this only
  100.    * applies to HTML <link> elements.
  101.    */
  102.   NS_IMETHOD LinkRemoved() = 0;
  103. };
  104.  
  105. #endif /* nsILink_h___ */
  106.